home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / pcl / docs.lha / latexinfo / manual / latexinfo2.toc < prev    next >
Text File  |  1992-02-26  |  17KB  |  220 lines
  1. \contentsline {chapter}{\numberline {1}Overview of LaTeXinfo}{3}
  2. \contentsline {section}{\numberline {1.1}Advantages of LaTeXinfo over TeXinfo}{4}
  3. \contentsline {section}{\numberline {1.2}Info files}{5}
  4. \contentsline {section}{\numberline {1.3}Printed Manuals}{6}
  5. \contentsline {section}{\numberline {1.4}\back -commands}{6}
  6. \contentsline {section}{\numberline {1.5}A Short Sample LaTeXinfo File}{8}
  7. \contentsline {section}{\numberline {1.6}The Structure of this Manual}{11}
  8. \contentsline {part}{\uppercase {i}\phspace {1em}LaTeX}{13}
  9. \contentsline {chapter}{\numberline {2}Beginning a LaTeXinfo File}{15}
  10. \contentsline {section}{\numberline {2.1}General Syntactic Conventions}{15}
  11. \contentsline {subsection}{\numberline {2.1.1}Comments}{16}
  12. \contentsline {section}{\numberline {2.2}What a LaTeXinfo File Must Have}{16}
  13. \contentsline {section}{\numberline {2.3}Six Parts of a LaTeXinfo File}{17}
  14. \contentsline {section}{\numberline {2.4}The LaTeXinfo File Header}{18}
  15. \contentsline {subsection}{\numberline {2.4.1}The Documentstyle}{18}
  16. \contentsline {subsection}{\numberline {2.4.2}\code {\back setfilename}}{18}
  17. \contentsline {subsection}{\numberline {2.4.3}New Indexes}{19}
  18. \contentsline {subsection}{\numberline {2.4.4}Customizing Your Layout}{19}
  19. \contentsline {subsubsection}{\numberline {2.4.4.1}Paragraph Indenting}{20}
  20. \contentsline {section}{\numberline {2.5}The Title and Copyright Pages}{20}
  21. \contentsline {subsection}{\numberline {2.5.1}Titlepage}{20}
  22. \contentsline {subsection}{\numberline {2.5.2}The Copyright Page and Printed Permissions}{21}
  23. \contentsline {section}{\numberline {2.6}Generating a Table of Contents}{22}
  24. \contentsline {section}{\numberline {2.7}The Top Node and Master Menu}{23}
  25. \contentsline {subsection}{\numberline {2.7.1}Parts of a Master Menu}{24}
  26. \contentsline {section}{\numberline {2.8}Software Copying Conditions}{25}
  27. \contentsline {subsection}{\numberline {2.8.1}Sample Permissions}{26}
  28. \contentsline {subsection}{\numberline {2.8.2}Titlepage Copying Permissions}{26}
  29. \contentsline {section}{\numberline {2.9}Ending a LaTeXinfo File}{26}
  30. \contentsline {subsection}{\numberline {2.9.1}Making a Bibliography}{27}
  31. \contentsline {subsection}{\numberline {2.9.2}Index Menus and Printing an Index}{28}
  32. \contentsline {subsection}{\numberline {2.9.3}\code {\back end\{ document\} } File Ending}{29}
  33. \contentsline {chapter}{\numberline {3}Chapter Structuring}{31}
  34. \contentsline {section}{\numberline {3.1}Tree Structure of Sections}{31}
  35. \contentsline {section}{\numberline {3.2}Types of Structuring Command}{33}
  36. \contentsline {section}{\numberline {3.3}Chapter}{33}
  37. \contentsline {section}{\numberline {3.4}Appendix}{33}
  38. \contentsline {section}{\numberline {3.5}Section}{33}
  39. \contentsline {section}{\numberline {3.6}Subsection}{34}
  40. \contentsline {section}{\numberline {3.7}Subsubsection}{34}
  41. \contentsline {chapter}{\numberline {4}Marking Words and Phrases}{35}
  42. \contentsline {section}{\numberline {4.1}Indicating Definitions, Commands, etc.}{35}
  43. \contentsline {subsection}{\numberline {4.1.1}\code {\back code}\{ \var {sample-code}\} }{36}
  44. \contentsline {subsection}{\numberline {4.1.2}\code {\back kbd}\{ \var {keyboard-characters}\} }{37}
  45. \contentsline {subsection}{\numberline {4.1.3}\code {\back key}\{ \var {key-name}\} }{37}
  46. \contentsline {subsection}{\numberline {4.1.4}Ctrl}{38}
  47. \contentsline {subsection}{\numberline {4.1.5}\code {\back samp}\{ \var {text}\} }{39}
  48. \contentsline {subsection}{\numberline {4.1.6}\code {\back var}\{ \var {metasyntactic-variable}\} }{39}
  49. \contentsline {subsection}{\numberline {4.1.7}\code {\back file}\{ \var {file-name}\} }{40}
  50. \contentsline {subsection}{\numberline {4.1.8}\code {\back dfn}\{ \var {term}\} }{40}
  51. \contentsline {section}{\numberline {4.2}Emphasizing Text}{41}
  52. \contentsline {subsection}{\numberline {4.2.1}\code {\back emph}\{ \var {text}\} and \code {\back strong}\{ \var {text}\} }{41}
  53. \contentsline {subsection}{\numberline {4.2.2}The Small Caps Font}{41}
  54. \contentsline {subsection}{\numberline {4.2.3}Fonts for Printing, Not Info}{42}
  55. \contentsline {section}{\numberline {4.3}Special Insertions}{42}
  56. \contentsline {subsection}{\numberline {4.3.1}Inserting \code {\back }, Braces, and Periods}{43}
  57. \contentsline {subsubsection}{\numberline {4.3.1.1}Inserting \code {\back }---\back back}{43}
  58. \contentsline {subsubsection}{\numberline {4.3.1.2}Inserting \samp {\{ } and \samp {\} }---\back \{ and \back \} }{43}
  59. \contentsline {subsubsection}{\numberline {4.3.1.3}Spacing After Colons and Periods}{43}
  60. \contentsline {subsection}{\numberline {4.3.2}\code {\back dmn}\{ \var {dimension}\} : Format a Dimension}{44}
  61. \contentsline {subsection}{\numberline {4.3.3}Inserting Ellipsis, Dots, and Bullets}{44}
  62. \contentsline {subsection}{\numberline {4.3.4}Inserting \LaTeX {} and the Copyright Symbol}{45}
  63. \contentsline {subsection}{\numberline {4.3.5}Inserting a Minus Sign}{45}
  64. \contentsline {subsection}{\numberline {4.3.6}Inserting Characters Verbatim}{46}
  65. \contentsline {chapter}{\numberline {5}Displaying Material}{47}
  66. \contentsline {section}{\numberline {5.1}Quotations}{48}
  67. \contentsline {subsection}{\numberline {5.1.1}Quotations}{48}
  68. \contentsline {section}{\numberline {5.2}Justifying Text}{49}
  69. \contentsline {subsection}{\numberline {5.2.1}Left Justification and Right Justification}{49}
  70. \contentsline {subsubsection}{\numberline {5.2.1.1}Center Environment}{49}
  71. \contentsline {section}{\numberline {5.3}Display Environments}{50}
  72. \contentsline {subsection}{\numberline {5.3.1}\code {\back begin\{ display\} }}{50}
  73. \contentsline {subsection}{\numberline {5.3.2}\code {\back begin\{ format\} }}{50}
  74. \contentsline {section}{\numberline {5.4}Examples and Verbatim}{50}
  75. \contentsline {subsection}{\numberline {5.4.1}\code {\back begin\{ example\} }}{50}
  76. \contentsline {subsection}{\numberline {5.4.2}\code {\back noindent}}{51}
  77. \contentsline {subsection}{\numberline {5.4.3}\code {\back begin\{ lisp\} }}{52}
  78. \contentsline {subsection}{\numberline {5.4.4}Verbatim Environment}{52}
  79. \contentsline {section}{\numberline {5.5}Controlling Indentation}{53}
  80. \contentsline {subsection}{\numberline {5.5.1}exdent: Undoing a Line's Indentation}{53}
  81. \contentsline {section}{\numberline {5.6}Drawing Cartouches Around Examples}{53}
  82. \contentsline {section}{\numberline {5.7}Special Glyphs for Examples}{54}
  83. \contentsline {subsection}{\numberline {5.7.1}\result {}: Indicating Evaluation}{54}
  84. \contentsline {subsection}{\numberline {5.7.2}\expansion {}: Indicating an Expansion}{55}
  85. \contentsline {subsection}{\numberline {5.7.3}\print {}: Indicating Printed Output}{55}
  86. \contentsline {subsection}{\numberline {5.7.4}\error {}: Indicating an Error Message}{56}
  87. \contentsline {subsection}{\numberline {5.7.5}\equiv {}: Indicating Equivalence}{56}
  88. \contentsline {subsection}{\numberline {5.7.6}Indicating Point in a Buffer}{57}
  89. \contentsline {section}{\numberline {5.8}Conditionally Visible Text}{57}
  90. \contentsline {subsection}{\numberline {5.8.1}Using Ordinary {\prm L\kern -.36em\raise .3ex\hbox {\psc a}\kern -.15em T\kern -.1667em\lower .7ex\hbox {E}\kern -.125emX}{} Commands}{58}
  91. \contentsline {chapter}{\numberline {6}Making Lists Tables and Descriptions}{59}
  92. \contentsline {section}{\numberline {6.1}Itemize Environment}{60}
  93. \contentsline {section}{\numberline {6.2}Enumerate Environment}{60}
  94. \contentsline {section}{\numberline {6.3}Description Environment}{61}
  95. \contentsline {section}{\numberline {6.4}Tabular Environment}{62}
  96. \contentsline {section}{\numberline {6.5}Figures and Tables}{63}
  97. \contentsline {chapter}{\numberline {7}Formatting Paragraphs}{65}
  98. \contentsline {section}{\numberline {7.1}Making and Preventing Breaks}{65}
  99. \contentsline {section}{\numberline {7.2}The Line Breaking Commands}{65}
  100. \contentsline {subsection}{\numberline {7.2.1}\code {\back *}: Generate Line Breaks}{65}
  101. \contentsline {subsection}{\numberline {7.2.2}Preventing Line Breaks}{66}
  102. \contentsline {subsection}{\numberline {7.2.3}Inserting Blank Lines}{66}
  103. \contentsline {section}{\numberline {7.3}The Page Breaking Commands}{67}
  104. \contentsline {subsection}{\numberline {7.3.1}Start a New Page}{67}
  105. \contentsline {subsection}{\numberline {7.3.2}Putting things on the Same Page}{67}
  106. \contentsline {subsection}{\numberline {7.3.3}Prevent Page Breaks}{67}
  107. \contentsline {section}{\numberline {7.4}Refilling Paragraphs}{68}
  108. \contentsline {section}{\numberline {7.5}Always Refilling Paragraphs}{69}
  109. \contentsline {chapter}{\numberline {8}Citations and Footnotes}{71}
  110. \contentsline {section}{\numberline {8.1}Footnotes}{71}
  111. \contentsline {section}{\numberline {8.2}Citations}{72}
  112. \contentsline {chapter}{\numberline {9}Input and Include Files}{73}
  113. \contentsline {section}{\numberline {9.1}Input Files}{73}
  114. \contentsline {section}{\numberline {9.2}Include Files}{73}
  115. \contentsline {subsection}{\numberline {9.2.1}How to Use Include Files }{74}
  116. \contentsline {subsection}{\numberline {9.2.2}Sample File with \code {\back include}}{74}
  117. \contentsline {chapter}{\numberline {10}Definition Commands}{77}
  118. \contentsline {section}{\numberline {10.1}Untyped Languages Definition Commands}{78}
  119. \contentsline {subsection}{\numberline {10.1.1}The Template for a Definition}{78}
  120. \contentsline {subsection}{\numberline {10.1.2}Optional and Repeated Parameters}{79}
  121. \contentsline {subsection}{\numberline {10.1.3}The Definition Commands}{80}
  122. \contentsline {subsection}{\numberline {10.1.4}Functions}{80}
  123. \contentsline {subsection}{\numberline {10.1.5}Variables}{81}
  124. \contentsline {section}{\numberline {10.2}C Functions}{82}
  125. \contentsline {subsection}{\numberline {10.2.1}Functions in Typed Languages}{82}
  126. \contentsline {subsection}{\numberline {10.2.2}Variables in Typed Languages}{84}
  127. \contentsline {section}{\numberline {10.3}Object-Oriented Programming}{85}
  128. \contentsline {subsection}{\numberline {10.3.1}Data Types}{87}
  129. \contentsline {section}{\numberline {10.4}A Sample Function Definition}{88}
  130. \contentsline {part}{\uppercase {ii}\phspace {1em}Info}{91}
  131. \contentsline {chapter}{\numberline {11}Nodes and Menus}{93}
  132. \contentsline {section}{\numberline {11.1}Node and Menu Illustration}{93}
  133. \contentsline {section}{\numberline {11.2}\code {\back node}}{94}
  134. \contentsline {subsection}{\numberline {11.2.1}Writing a Node Line}{95}
  135. \contentsline {section}{\numberline {11.3}Menu Environment}{96}
  136. \contentsline {subsection}{\numberline {11.3.1}Writing a Menu Item}{97}
  137. \contentsline {subsection}{\numberline {11.3.2}A Menu Example}{98}
  138. \contentsline {section}{\numberline {11.4}Referring to Other Info Files}{99}
  139. \contentsline {chapter}{\numberline {12}Making Cross References}{101}
  140. \contentsline {section}{\numberline {12.1}Different Cross Reference Commands}{101}
  141. \contentsline {section}{\numberline {12.2}Parts of a Cross Reference}{102}
  142. \contentsline {section}{\numberline {12.3}\code {\back xref}}{103}
  143. \contentsline {subsection}{\numberline {12.3.1}\code {\back xref} with One Argument}{104}
  144. \contentsline {subsection}{\numberline {12.3.2}\code {\back xref} with Two Arguments}{105}
  145. \contentsline {subsection}{\numberline {12.3.3}\code {\back xref} with Three Arguments}{105}
  146. \contentsline {subsection}{\numberline {12.3.4}\code {\back xref} with Four and Five Arguments}{106}
  147. \contentsline {section}{\numberline {12.4}Naming a `Top' Node}{108}
  148. \contentsline {section}{\numberline {12.5}\code {\back nxref}}{108}
  149. \contentsline {section}{\numberline {12.6}\code {\back pxref}}{109}
  150. \contentsline {section}{\numberline {12.7}\code {\back inforef}}{110}
  151. \contentsline {chapter}{\numberline {13}Creating Indices}{113}
  152. \contentsline {section}{\numberline {13.1}Making Index Entries}{113}
  153. \contentsline {section}{\numberline {13.2}Defining the Entries of an Index}{114}
  154. \contentsline {subsection}{\numberline {13.2.1}Declaring Indices}{115}
  155. \contentsline {subsection}{\numberline {13.2.2}Special Index Entries}{116}
  156. \contentsline {section}{\numberline {13.3}Combining Indices}{116}
  157. \contentsline {chapter}{\numberline {14}Creating and Installing an Info File}{119}
  158. \contentsline {section}{\numberline {14.1}Creating an Info file}{119}
  159. \contentsline {subsection}{\numberline {14.1.1}The latexinfo-format Commands}{119}
  160. \contentsline {subsection}{\numberline {14.1.2}Tag Files and Split Files}{120}
  161. \contentsline {section}{\numberline {14.2}Installing an Info File}{121}
  162. \contentsline {subsection}{\numberline {14.2.1}The \file {dir} File}{121}
  163. \contentsline {subsection}{\numberline {14.2.2}Listing a New Info File}{122}
  164. \contentsline {subsection}{\numberline {14.2.3}Info Files in Other Directories}{122}
  165. \contentsline {part}{\uppercase {iii}\phspace {1em}Emacs}{125}
  166. \contentsline {chapter}{\numberline {15}Using LaTeXinfo Mode}{127}
  167. \contentsline {section}{\numberline {15.1}Inserting Frequently Used Commands}{128}
  168. \contentsline {section}{\numberline {15.2}Showing the Section Structure of a File}{129}
  169. \contentsline {section}{\numberline {15.3}Updating Nodes and Menus}{129}
  170. \contentsline {subsection}{\numberline {15.3.1}Updating Requirements}{132}
  171. \contentsline {subsection}{\numberline {15.3.2}Other Updating Commands}{132}
  172. \contentsline {subsection}{\numberline {15.3.3}\code {latexinfo-multiple-files-update}}{133}
  173. \contentsline {section}{\numberline {15.4}Formatting for Info}{134}
  174. \contentsline {section}{\numberline {15.5}Formatting and Printing}{135}
  175. \contentsline {section}{\numberline {15.6}LaTeXinfo Mode Summary}{136}
  176. \contentsline {chapter}{\numberline {16}Printing Hardcopy}{139}
  177. \contentsline {section}{\numberline {16.1}How to Print Using Shell Commands}{139}
  178. \contentsline {section}{\numberline {16.2}Printing from an Emacs Shell}{141}
  179. \contentsline {section}{\numberline {16.3}Formatting and Printing in LaTeXinfo Mode}{141}
  180. \contentsline {section}{\numberline {16.4}Using the Local Variables List}{142}
  181. \contentsline {section}{\numberline {16.5}Preparing for Use of \LaTeX {}}{143}
  182. \contentsline {section}{\numberline {16.6}Overfull ``Hboxes''}{143}
  183. \contentsline {chapter}{\numberline {17}Catching Formatting Mistakes}{145}
  184. \contentsline {section}{\numberline {17.1}Catching Errors with Info Formatting}{145}
  185. \contentsline {section}{\numberline {17.2}Catching Errors with \LaTeX {} Formatting}{146}
  186. \contentsline {section}{\numberline {17.3}Using \code {latexinfo-show-structure}}{147}
  187. \contentsline {section}{\numberline {17.4}Using \code {occur}}{148}
  188. \contentsline {section}{\numberline {17.5}Finding Badly Referenced Nodes}{149}
  189. \contentsline {subsection}{\numberline {17.5.1}Running \code {Info-validate}}{149}
  190. \contentsline {subsection}{\numberline {17.5.2}Creating an Unsplit File}{150}
  191. \contentsline {subsection}{\numberline {17.5.3}Tagifying a File}{150}
  192. \contentsline {subsection}{\numberline {17.5.4}Splitting a File Manually}{151}
  193. \contentsline {chapter}{\numberline {18}Extending LaTeXinfo}{153}
  194. \contentsline {section}{\numberline {18.1}Optional Style Files}{153}
  195. \contentsline {subsection}{\numberline {18.1.1}The fvpindex Style}{153}
  196. \contentsline {subsection}{\numberline {18.1.2}fvpindex Style}{153}
  197. \contentsline {subsection}{\numberline {18.1.3}Clisp Style}{154}
  198. \contentsline {section}{\numberline {18.2}LaTeXinfo support for European languages}{157}
  199. \contentsline {subsection}{\numberline {18.2.1}german.sty}{157}
  200. \contentsline {subsubsection}{\numberline {18.2.1.1}Commands to be used by the end users}{158}
  201. \contentsline {subsubsection}{\numberline {18.2.1.2}Obsolete Commands}{159}
  202. \contentsline {subsubsection}{\numberline {18.2.1.3}Lower Level Commands and Features}{159}
  203. \contentsline {section}{\numberline {18.3}Writing Your Own Style Files}{160}
  204. \contentsline {part}{\uppercase {iv}\phspace {1em}Appendices}{161}
  205. \contentsline {chapter}{\numberline {A}Installing LaTeXinfo}{163}
  206. \contentsline {section}{\numberline {A.1}Compiling LaTeXinfo}{163}
  207. \contentsline {section}{\numberline {A.2}Installing the LaTeXinfo Distribution}{165}
  208. \contentsline {subsection}{\numberline {A.2.1}Installing the Style Files}{165}
  209. \contentsline {chapter}{\numberline {B}Converting Files to LaTeXinfo}{167}
  210. \contentsline {section}{\numberline {B.1}Converting LaTeX Files to LaTeXinfo}{167}
  211. \contentsline {subsection}{\numberline {B.1.1}l2latexinfo.el}{168}
  212. \contentsline {section}{\numberline {B.2}Converting TeXinfo Files into LaTeXinfo Files}{169}
  213. \contentsline {subsection}{\numberline {B.2.1}Differences from TeXinfo}{169}
  214. \contentsline {subsection}{\numberline {B.2.2}t2latexinfo.el}{170}
  215. \contentsline {section}{\numberline {B.3}Converting Scribe Files to LaTeXinfo}{171}
  216. \contentsline {chapter}{\numberline {C}Obtaining \LaTeX {}}{173}
  217. \contentsline {chapter}{\numberline {D}Command List}{175}
  218. \contentsline {chapter}{Command Index}{187}
  219. \contentsline {chapter}{Concept Index}{191}
  220.